home *** CD-ROM | disk | FTP | other *** search
/ BBS Toolkit / BBS Toolkit.iso / tag_bbs / tag_sh41.zip / SHUTTLE.DOC < prev    next >
Text File  |  1993-04-15  |  22KB  |  510 lines
  1.  
  2.           Are you tired of the curious caller?  That annoying caller 
  3.           who logs on your BBS once, -forgets s/he called, or forgets 
  4.           the password s/he picked, and bequeaths you a wasted user 
  5.           record?
  6.  
  7.           Are you a SysOp who'd like to screen potential users, then
  8.           determine if you should allow them an account on your BBS? 
  9.  
  10.           Are you looking for an extra edge against the 'Big Hack-
  11.           Attack' that plagues so many SysOp's running "open" TAG 
  12.           systems?
  13.  
  14.           Are you a SysOp who caters to the non-public domain LEECH
  15.           and need a way to add more panache to your system (recent 
  16.           upload bulletins etc.) that the general public can't see?
  17.  
  18.  
  19.                     YES?  WELL, THEN READ ON, BECAUSE.......
  20.  
  21.  
  22.  TTTTTTTT  AAAAAAA   GGGGGGG             SSSSSSSS  HH   HH   UU    UU  TTTTTTTT
  23.     TT     AA   AA   GG   GG             SS    SS  HH   HH   UU    UU     TT
  24.     TT     AA   AA   GG                  SS        HH   HH   UU    UU     TT 
  25.     TT     AAAAAAA   GG  GGG             SSSSSSSS  HHHHHHH   UU    UU     TT
  26.     TT     AA   AA   GG   GG                   SS  HH   HH   UU    UU     TT  
  27.     TT     AA   AA   GG   GG             SS    SS  HH   HH   UU    UU     TT
  28.     TT     AA   AA   GGGGGGG  =========  SSSSSSSS  HH   HH   UUUUUUUU     TT
  29.                                V. 4.1  
  30.  
  31.  
  32.                     *_THE_*  Shuttle Log-on door for T.A.G.
  33.                          
  34.                                has arrived.
  35.  
  36.  
  37. Contents, by section order:
  38.  
  39. 1] Authors Note.
  40. 2] Installation.                
  41. 3] Configuration.                                
  42. 4] Questionnaire file, -options.
  43. 5] Miscellaneous features.
  44. 6] Undocumented features.
  45. 7] Acknowledgments, -credit where credit is due.
  46. 8] Possible future enhancements.
  47. 9] Support.
  48.  
  49. Special note : R.T.F.D. (Read The Faruking Docs!!) 
  50.  
  51. Translation  : Read  = That, which you are doing now.
  52.                Faruk = The handle I use on my BBS.
  53.                Docs  = The ascii file accompanying a program that explains the  
  54.                procedure for its setup and operation;  The one which so many
  55.                SysOp's try to avoid reading.
  56.  
  57.                                    TAG_SHUT
  58.                                  ------------
  59.                        A Shuttle Log-On Door for TAG BBS'
  60.                          Version 4.1, for T.A.G. 2.6d
  61.                      
  62.  
  63. 1] Authors note ... 
  64.  
  65.  
  66.      I wrote this door to fill a gap for converted Telegard SysOp's (I was once
  67. one of _them_ too!).  There are many SysOp's who have converted from Telegard
  68. to TAG, -or wish to, and one of the features they'd miss was a "Shuttle" menu.
  69. Personally, I found them to be quite annoying, but, since there was a need, I
  70. decided to satisfy it, and:  You know what?  Since I've been running it, I've
  71. come to appreciate not having my user records wasted by one time callers.
  72.  
  73.      Whether, I continue to work on this door, depends on the reception it gets
  74. from you as the end user, and the personal support I receive.  The program is
  75. provided as-is, without charge for those who choose to run it.  Please, _READ_
  76. the enclosed TAG_SHUT.REG file for further details.
  77.  
  78.  
  79.                                         Thank You,
  80.                                         Faruk You.     
  81.  
  82.  
  83.      You must follow a few simple steps to install, and configure TAG_SHUT to
  84.      run on your system.  This is a simple and painless procedure, as follows.
  85.  
  86.  
  87. 2] Installation. 
  88.  
  89.      Using the DOS MD command, create a directory to run TAG_SHUT from.  
  90.      Un-archive, or copy the files, SHUTTLE.EXE, SHUTTLE.OVR, and, optionally, 
  91.      NEWUSER.APP to your new directory.  
  92.  
  93.           IMPORTANT NOTES:  If no NEWUSER.APP file is placed in your 
  94.           TAG_SHUT directory, a message will be displayed to new users 
  95.           stating your system is not accepting new user applications.
  96.  
  97.      A sample WELCOME.BAT file is included; you may use this for reference,
  98.      and edit your existing WELCOME.BAT.  If you don't currently use a
  99.      WELCOME.BAT file, please copy the sample to your main BBS directory, and
  100.      edit it to suit your system, and paths.
  101.  
  102.      WELCOME.BAT should change to your TAG_SHUT directory and run
  103.      SHUTTLE.EXE.
  104.  
  105.    HINT:  Copy WELCOME.MSG, and WELCOME.CLR from TAG's (A, D or GFILES) 
  106.           directory to your SHUTTLE directory.  Replace the originals with 
  107.           dummy files of the same name.  This will allow both TAG, and TAG_SHUT
  108.           to run detect ansi rountines without errors:  TAG_SHUT will do the
  109.           actual WELCOME file display.  Makes for a nice seamless interface.
  110.  
  111.           If TAG_SHUT finds, either MENU.CLR or MENU.MSG in the directory it is
  112.           run from, those files will be displayed in place of the built in main
  113.           shuttle menu.  
  114.  
  115. 3] Configuration.
  116.  
  117.      Change to the directory you created for SHUTTLE.EXE, and run the command
  118.      as follows:
  119.  
  120.      SHUTTLE CONFIG
  121.  
  122.      The following configuration menu will be displayed:
  123.  
  124.  ╔═[■]═════════════ Edit TAG_SHUT configuration - ESC to end ═════════════════╗
  125.  ║ Main system password                  SYSTEM   (NOTE: See TAG_SHUT.REG)    ║
  126.  ║ Days before system password change    28       (NOTE: See TAG_SHUT.REG)    ║
  127.  ║ Length of generated system password   8        (NOTE: See TAG_SHUT.REG)    ║
  128.  ║ Force local logons to use shuttle     Y        (NOTE: See TAG_SHUT.REG)    ║
  129.  ║ Ansi detection enabled                Y        (NOTE: See TAG_SHUT.REG)    ║
  130.  ║ Maximum time in door                  5                                    ║
  131.  ║ Inactivity time out                   3                                    ║
  132.  ║ Path to STATUS.DAT file               D:\COM\TAG                           ║
  133.  ║ Who to send application letter to     SYSOP                                ║
  134.  ║ Board Number for *.MSG directory      D:\COM\TAG\EMAIL                     ║
  135.  ║ Subject line for user application     New User application                 ║
  136.  ║ Password for reading reply to user    READ_IT                              ║
  137.  ║  Command keys-                                                             ║
  138.  ║ KEY1      Log on To system(requires PASSWORD)                              ║
  139.  ║ KEY2      Get system password(must be a user)                              ║
  140.  ║ KEY3      Apply for account on system                                      ║
  141.  ║ KEY4      Chat with SysOp                                                  ║
  142.  ║ KEY5      Read reply for access, from SysOp                                ║
  143.  ║ KEY6      Good bye-log-off, beat it                                        ║
  144.  ╚════════════════════════════════════════════════════════════════════════════╝
  145.  
  146.      You will note that some command descriptions below are preceded by an *
  147.      symbol:  These commands are functional.  However, to unlock their full
  148.      potential, you must register TAG_SHUT.  Please refer to the accompanying
  149.      TAG_SHUT.REG file for further information. 
  150.  
  151.      Use your up and down arrow keys to scroll through the various fields. 
  152.      Pressing enter while in a field will allow editing of that field.
  153.  
  154.      When you are finished editing, press your escape key; a file named
  155.      TAG_SHUT.DAT will be created, and your changes will be saved to it. 
  156.  
  157.  
  158. [Main system password]
  159.  
  160. *    {This command may not be manually changed in the evaluation version. 
  161.      TAG_SHUT will automatically generate new passwords for you.}
  162.  
  163.      This is the password to move past TAG_SHUT, into the T.A.G. logon process.
  164.      Only validated users, or users whom you have granted access through a
  165.      reply to a new user application will know the system password.    
  166. [Days before system password change]
  167.  
  168. *    {This command may only be set between 1 - 14 days, and cannot be disabled
  169.      in the evaluation version.}
  170.  
  171.      If value is set to 0, this option is nullified.  Any value set above 0
  172.      will be represent the number of days before TAG_SHUT will automatically
  173.      update a new system password.  The password is chosen randomly.
  174.  
  175. [Length of generated system password]
  176.  
  177. *    {The length of this option is set to 8, and cannot be changed in the
  178.      evaluation version.}     
  179.  
  180.      This value represents the number of characters the randomly generated 
  181.      system password will contain.
  182.  
  183. [Force local logons to use shuttle]
  184.  
  185. *    {The value of this option is set to yes, and cannot be changed in the
  186.      evaluation version.}    
  187.  
  188.      This option defines whether a local logon will cause TAG_SHUT to be
  189.      called as a prelude to T.A.G.
  190.  
  191. [Ansi detection enabled]
  192.  
  193. *    {The value of this option is set to yes, and cannot be changed in the
  194.      evaluation version.}    
  195.  
  196.      This option specifies whether TAG_SHUT will display to the user, that is
  197.      has detected an Ansi driver loaded on their system.  
  198.  
  199. [Maximum time in door]
  200.  
  201.      This value represents the maximum time a user will be allowed to remain
  202.      in the door before TAG_SHUT automatically resets.
  203.  
  204. [Inactivity time out]
  205.  
  206.      This value represents the time TAG_SHUT will wait for a keystroke before
  207.      assuming no carrier is present, and automatically resetting.
  208.  
  209. [Path to STATUS.DAT file]
  210.  
  211.      This is where TAG_SHUT will locate your STATUS.DAT file.  This will be
  212.      your main T.A.G., or BBS directory.
  213.  
  214. [Who to send user application to]
  215.  
  216.      This is the name of the person who will process, and answer the user
  217.      applications.  If you will be answering the letters, set this to the user
  218.      name contained in your account.  ie: SYSOP, SYSTEM OPERATOR, FARUK YOU.
  219.  
  220. [Board Number for *.MSG directory]
  221.  
  222.      This value must be set to a valid Fido Style (*.msg) message base.  
  223.  
  224. [Subject line for user application]
  225.  
  226.      This line decides the text that will form the subject line of the user
  227.      application letter.  Set this to a subject that will allow easy
  228.      recognition of your user application letters, such as the default does.
  229.      
  230. [Password for reading reply to user]
  231.  
  232.      This is the password a potential user will enter to read your reply to
  233.      their user application letter.  To prevent un-authorized reading of  
  234.      personal mail, only un-validated users will have access to this command.
  235.  
  236.      NOTE:  The sample read password has been hard coded into the sample
  237.      questionnaire for your convenience, and reference.
  238.  
  239.      Since your reply to the user application will probably contain the system
  240.      password for approved applications, you may also choose not to display a
  241.      read password, and advise potential users of the read password by a voice
  242.      call. 
  243.  
  244. [Command keys-]
  245.  
  246.      Listed in order, the command keys each perform a specific function as
  247.      outlined in their defaults.  The command text may be changed as you
  248.      prefer, but the actual commands are static.  
  249.   
  250.      The keys themselves, are 'hotwords, -not to be confused with, but not
  251.      unlike 'hotkeys'.  They may be changed to read as you see fit, but they
  252.      must all remain the same length for the 'hotword' feature to be in effect. 
  253.      If the length of one description differs from the others, the command need
  254.      be followed by a carriage return from the user.  
  255.  
  256.      The editing of command keys takes place in a windowed sub-menu.  A couple
  257.      of options are added when you are editing command keys:  Once you scroll
  258.      to, and enter on a command key to edit, you will use your TAB key to
  259.      change fields.  When you are finished editing, press F10 to save your
  260.      changes, or press your ESC to abort your changes.  You will then be
  261.      returned to the main configuration menu.    
  262.  
  263.                Example:
  264.  
  265.                KEY1    Log on to system(requires password)
  266.                
  267.                          -may be changed to read-
  268.  
  269.                L       Log on system, -requires password.
  270.      
  271.                
  272.                KEY2    Get system password(must be user)
  273.  
  274.                W       What is system password, -users only.     
  275.  
  276.  
  277.      All keys, and descriptions may be redefined, but the commands will always
  278.      remain the same.  In the case of our example, the KEY commands remained
  279.      the same length, -at one character, and so the 'hotword' feature would
  280.      remain enabled.
  281.      
  282.  
  283.      KEY1 will allow a user who has the system password to pass through
  284.      TAG_SHUT, and proceed with the T.A.G. logon process.
  285.  
  286.      KEY2 allows a registered user to obtain the current system password by
  287.      entering their correct user name, and password.
  288.      
  289.      KEY3 allows new, un-validated users to fill out your user application, to
  290.      apply for an account on your system.  As I pointed out previously, a
  291.      NEWUSER.APP file _must_ be present in your TAG_SHUT directory for this
  292.      command to operate. 
  293.  
  294.      KEY4 allows a user to request a chat with the SysOp.  Chat audio is
  295.      enabled, and disabled by toggling the SCROLL LOCK key.
  296.  
  297.      KEY5 allows user to read your reply to their new user application letter.
  298.      Remember that you must have supplied the required password for this
  299.      command through the NEWUSER.APP file, or advised the user by voice of the
  300.      password.  Only un-validated users may access this command.
  301.  
  302.      KEY6 allows a user to log off the shuttle.
  303.      
  304. 4] Questionnaire file -options.
  305.  
  306.      A sample NEWUSER.APP has been provided for your convenience, and
  307.      reference.
  308.  
  309.      If you would like to expand on the sample, you may refer to the example
  310.      below.  Read your T.A.G. documentation for further information.
  311.  
  312. Example file:
  313.  
  314.  
  315. #What's your real name ? @Q@
  316. #What's your reason for wishing access to this bbs? >@Q@
  317.  
  318. cmd color 0 6 0
  319. #Are you a sysop of a bbs? @O@
  320. #Is your hair brown? @O@
  321. cmd color 0 3 0
  322. cmd cls
  323. ...     display a screen of system info   ...
  324. .
  325. .
  326. This is the end of the displayed page, press any key to go on@P@
  327. cmd color 0 4 0 
  328. Thanks for your time. Please call back in a day or two to check
  329. and see if you have a reply to your application.
  330.  
  331.  
  332.      Valid commands for use in the newuser.app questionnaire file:
  333.  
  334. @Q@        - Specifies a MANDATORY question.  User must supply at least 1       
  335.              character of input to answer and go on.
  336.  
  337. @O@        - Specifies an OPTIONAL question to ask of the user.  Just hitting   
  338.              C/R will go on past the question and output a blank line to the    
  339.              answer message.
  340.  
  341. @$@       - Specifies input of a phone number from the user (North American     
  342.             format).
  343.  
  344. >         - Placed in front of either of the @Q@ or @O@ prompts will force a    
  345.             line feed and carriage return before prompting for an answer to the 
  346.             output line.
  347.  
  348. #         - Forces line to be included in the *.MSG created for SysOp.
  349.  
  350. @P@       - Force a pause at current line. Produces a [Paused] prompt.
  351.  
  352. cmd cls   - clears both local and remote screens when processed.
  353.  
  354. cmd color - changes colors. 
  355.             Command syntax : cmd color x y z
  356.                              x being background color
  357.                              y being foreground color
  358.                              z being blinking if 1 and no blink if 0
  359.  
  360.      Valid Background Colours :
  361.  
  362.             0  : black                  4  : red
  363.             1  : blue                   5  : magenta
  364.             2  : green                  6  : brown
  365.             3  : cyan                   7  : light gray
  366.  
  367. Valid Foreground Colours :
  368.  
  369.    0  : black    4  : red           8  : dark gray     12  : light red
  370.    1  : blue     5  : magenta       9  : light blue    13  : light magenta
  371.    2  : green    6  : brown        10  : light green   14  : yellow
  372.    3  : cyan     7  : light gray   11  : light cyan    15  : white
  373.  
  374.  
  375.  
  376.           See that blank line right up here ^^^^^^^^^^^^^ ?  
  377.  
  378.           A blank line is just that, A BLANK LINE, and is displayed 
  379.           that way.  Text lines may also be added wherever you so choose.
  380.  
  381.  
  382. 5] Miscellaneous features.
  383.  
  384.  
  385.           The F10 key will initiate a chat mode at ANY time.  Split screen
  386.           mode or single line (you type first, user types next) will be
  387.           chosen depending on whether or not the user has ansi.
  388.  
  389.           The F1 key when pressed in chat will drop the user back to the
  390.           point at which they left off.
  391.  
  392.           The F9 key when pressed, hits the user with fake line noise.
  393.  
  394.           The F8 key when pressed, hits the user with fake line noise and
  395.           then disconnects the call.
  396.  
  397.           The chat page is enabled/disabled via the scroll lock key.
  398.           Scroll on / chat page bell on. Scroll off / chat page bell off.
  399.      
  400.           Questionnaire lines are limited and truncated to 78 characters.
  401.  
  402.    NOTE:  TAG_SHUT will display non-ansi screen writes on the far left of the
  403.           screen, rather than the centred display of an ansi screen. 
  404.  
  405.  
  406. 6] Undocumented features.
  407.  
  408.  
  409.      In keeping with the true tradition of TAG, bugs are non existent unless
  410. they are proven to be FTSC compatible ANNOYING and/or OFFENSIVE.  Otherwise,
  411. they are to be considered undocumented features, all of which I would very much
  412. like to hear of so that I may include them in the docs. :-)
  413.  
  414.      Further to this portion of the documentation, all undocumented features
  415. will see inclusion to the system/docs in approximately a WWeek, which for those
  416. who may be as yet uninitiated, is roughly three weeks from the Tuesday after my
  417. Mothers 92`nd birthday (anytime sooner is a bonus for you!).
  418.  
  419.  
  420.  
  421. 7] Acknowledgements,  -Credit where credit is due.
  422.  
  423.  
  424.      First of all, I must give credit to my girlfriend Brita, without who's 
  425. patience and understanding this door would not exist.
  426.  
  427.      Thanks Sweetheart, and please continue to be as patient as you have.
  428.      Next, my children, Teddy and Hillary. You guys have sacrificed a lot
  429. of my time in order that I can develop this package.  I promise that come 
  430. summer, -one of these summers, we'll see lots of the good times again.
  431.  
  432.      I love you two guys!
  433.  
  434. Also,
  435.  
  436.  
  437.      A special thanks to,
  438.  
  439.                          
  440.                                  THE
  441.  
  442.       /\/\/\/\/\/\/\/\/\/\/\/\/\/\/\/\/\/\/\/\/\/\/\/\/\/\/\/\/\/\/\/\/\/\/\
  443.      /\/\/\/                                                          \/\/\/\
  444.     |   /\/    ______________        ______          ___________       \/\   |
  445.     |  / /    /             /|      /     /|        /          /\       \ \  |
  446.     | / /     TTTTTTTTTTTTTT/       AAAAAA /|       GGGGGGGGGGG\/|       \ \ |
  447.     |/\/ /\         TT |           AA|___AA /|      GG |      GG/      /\ \/\|
  448.     |-< <  >        TT |          AA/     AA /|     GG |   _____      <  > >-|
  449.     |\/\ \/         TT |         AAAAAAAAAAAA |     GG |  /     /|     \/ /\/|
  450.     | \ \           TT |         AA |      AA |     GG |__GGGGGG |       / / |
  451.     |  \ \          TT |         AA |      AA |     GG/       GG |      / /  |
  452.     |   \/\         TT/   <>     AA/       AA/  <>   GGGGGGGGG   | <> /\/    |
  453.      \/\/\/\                                                          /\/\/\/
  454.       \/\/\/\/\/\/\/\/\/\/\/\/\/\/\/\/\/\/\/\/\/\/\/\/\/\/\/\/\/\/\/\/\/\/\/
  455.  
  456.                                      TEAM
  457.  
  458.      Thanks guys, (Vic, Randy and Paul especially), if it were not for you guys
  459. and your generosity none of us would have this fine BBS package to run.
  460.  
  461.  
  462. and,          
  463.  
  464.                                 Rod Bowman
  465.                                    and
  466.  
  467.              ┌──────────────────────────────────────────────┐
  468.              │             MOTOR CITY SOFTWARE              │
  469.              │   ┌──────────────────────────────────────┐   │
  470.              │   │       JPDoor - Version 3.1 SE        │   │
  471.              │   │            ┌──────────┐              │   │
  472.              │   │            │\         │              │   │
  473.              │   │            │ \        │              │   │
  474.              │   │            │  \   P   │              │   │
  475.              │   │            │   \  A   │              │   │
  476.              │   │            │   │  S   │              │   │
  477.              │   │            │   │  C   │              │   │
  478.              │   │     5.5    │   │  A   │    6.0       │   │
  479.              │   │            │  o│  L   │              │   │
  480.              │   │            │   │      │              │   │
  481.              │   │            \   │──────┘              │   │
  482.              │   │             \  │                     │   │
  483.              │   └──────────────\ │─────────────────────┘   │
  484.              │      The Ultimate \│ Door Writing Unit.      │
  485.              └────────────────────┴─────────────────────────┘
  486.  
  487.              Don't be fooled! It's a dandy of a door interface.
  488.  
  489.  
  490. finally,     
  491.      ... those who tested TAG_SHUT. 
  492.  
  493.  
  494.  
  495. 8] Possible future enhancements.
  496.  
  497.      Complete rewrite of code to eliminate use of JPDoor and reduce memory
  498.      usage dramatically.  
  499.  
  500.      Ability to write NEWUSER.APP response to HUDSON style message base.
  501.  
  502.  
  503.                                    Enjoy the door!
  504.                                    Drew Smith  (aka Faruk You)
  505.  
  506.  
  507. 9] Support. 
  508.  
  509.      I can be reached via, TAG_DOORS, and TAG, echoes, or refer to TAG_SHUT.REG
  510. for my mailing address.